Add contributing guidelines to CONTRIBUTING.md #2845
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added contributing guidelines for the WordPress Playground project, detailing how to contribute, guidelines to follow, and links to relevant resources.
Updated links and standards for pull requests and coding guidelines.
Removed redundant line breaks and merged sentences for clarity.
Member
Author
|
Do you think this PR will be reviewed? @brandonpayton |
Collaborator
|
@theaminuli, thanks for submitting the PR, but I would like to know the impact of it. I have commented on the issue. I would like to understand how relevant this file is, once we have that information available in the README and https://wordpress.github.io/wordpress-playground/ I want to avoid content duplication because it can impact the maintenance of the docs. |
fellyph
requested changes
Nov 12, 2025
Collaborator
fellyph
left a comment
fellyph
left a comment
There was a problem hiding this comment.
Hi @theaminuli thanks for submitting the PR, I have a few suggestions
| - Documentation – see the [documentation section](https://wordpress.github.io/wordpress-playground/docs/contributing/documentation). | ||
| - Triage – see the [triage section](https://wordpress.github.io/wordpress-playground/contributing/#triaging-issues). | ||
| - Contributions to translations – see the [translations section](https://wordpress.github.io/wordpress-playground/contributing/translations). | ||
| - Reporting bugs – open an [issue](https://github.com/WordPress/wordpress-playground/issues/new) in the repository. |
Collaborator
There was a problem hiding this comment.
We can suggest the template issues:
Suggested change
| - Reporting bugs – open an [issue](https://github.com/WordPress/wordpress-playground/issues/new) in the repository. | |
| - Reporting bugs – open an [issue](https://github.com/WordPress/wordpress-playground/issues/new/choose) in the repository. |
|
|
||
| Here's a few quickstart guides to get you started: | ||
|
|
||
| - Code contributions – see the [developer section](https://wordpress.github.io/wordpress-playground/docs/contributing/code). |
Collaborator
There was a problem hiding this comment.
we can be consistent with the links:
Suggested change
| - Code contributions – see the [developer section](https://wordpress.github.io/wordpress-playground/docs/contributing/code). | |
| - Code contributions – see the [developer section](https://wordpress.github.io/wordpress-playground/contributing/code/). |
| Here's a few quickstart guides to get you started: | ||
|
|
||
| - Code contributions – see the [developer section](https://wordpress.github.io/wordpress-playground/docs/contributing/code). | ||
| - Documentation – see the [documentation section](https://wordpress.github.io/wordpress-playground/docs/contributing/documentation). |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Documentation – see the [documentation section](https://wordpress.github.io/wordpress-playground/docs/contributing/documentation). | |
| - Documentation – see the [documentation section](https://wordpress.github.io/wordpress-playground/contributing/documentation). |
|
|
||
| WordPress Playground is an open-source project and welcomes all contributors from code to design, and from documentation to triage. If the feature you need is missing, you are more than welcome to start a discussion, open an issue, and even propose a Pull Request to implement it. | ||
|
|
||
| Here's a few quickstart guides to get you started: |
Collaborator
There was a problem hiding this comment.
Suggested change
| Here's a few quickstart guides to get you started: | |
| Here are a few quickstart guides to get you started: |
| - Contributions to translations – see the [translations section](https://wordpress.github.io/wordpress-playground/contributing/translations). | ||
| - Reporting bugs – open an [issue](https://github.com/WordPress/wordpress-playground/issues/new) in the repository. | ||
| - Ideas, designs or anything else – open a [GitHub discussion](https://github.com/WordPress/wordpress-playground/discussions) and let's talk! | ||
|
|
Collaborator
There was a problem hiding this comment.
We can add a mention to the Playground Slack Channel:
- Connect with the Playground team at [`#playground` channel on WordPress Slack](https://wordpress.slack.com/archives/C04EWKGDJ0K)
| - Before submitting a pull request, review the [repository management and pull request best practices](https://wordpress.github.io/wordpress-playground/contributing/code), and follow the WordPress Playground coding and accessibility standards. | ||
| - WordPress Coding Standards [Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/) | ||
| - **Maintain compatibility:** If your changes affect shared functions, modules, or APIs, ensure they don’t break existing Playground environments or integrations. | ||
| - You maintain copyright over your contributions.By submitting a pull request, you agree to release your code under [Playground’s License](/LICENSE.md). |
Collaborator
There was a problem hiding this comment.
Suggested change
| - You maintain copyright over your contributions.By submitting a pull request, you agree to release your code under [Playground’s License](/LICENSE.md). | |
| - You maintain copyright over your contributions. By submitting a pull request, you agree to release your code under [Playground’s License](/LICENSE.md). |
| ## 🧭 Guidelines | ||
| - As with all WordPress projects, we’re committed to a **welcoming, inclusive, and respectful environment** for everyone. Please follow our [Code of Conduct](https://make.wordpress.org/handbook/community-code-of-conduct/). | ||
| - Before submitting a pull request, review the [repository management and pull request best practices](https://wordpress.github.io/wordpress-playground/contributing/code), and follow the WordPress Playground coding and accessibility standards. | ||
| - WordPress Coding Standards [Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/) |
Collaborator
There was a problem hiding this comment.
Suggested change
| - WordPress Coding Standards [Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/) | |
| - [WordPress Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What:
Created a new CONTRIBUTING.md file in the project root.
Why:
The repository didn’t have contribution guidelines.
This file helps new contributors understand how to set up the project, follow coding standards, and submit pull requests properly.
File Created:
CONTRIBUTING.md — includes:
Fixed: #2844